Documentation for class form

Inherits from 	matrix_object 

Properties declared in form 

Class Methods declared in form 
	new 
	new_with(number_of_entries) 

Methods declared in form 
	action 
		scroll_cell_to_visible(index) 
	any 
		add_entry(title) 
		cell_at(index) 
		insert_entry_at(title, index) 
		replace_cell_at(cell, index) 
		scroll_cell_to_visible(index) 
		selected_index 
		set_entry_width(width) 
		set_interline_spacing(spacing) 

Class 
#begin_class
form 
The class form is a sub-class of the class matrix_object. 
A form is a matrix object that may only have one column. There can only be form cells in a form.
Each row in the form is called an entry.
#end_class

Properties 

Methods 

#begin_method
add_entry(title) 
Adds a new entry with title at the end of the form.
Returns self.
Ex:
{form my_form}:add_entry("A title:")
#end_method

#begin_method
cell_at(index) 
Returns the cell at index. If index is out of bounds the method will return nil.
#end_method

#begin_method
insert_entry_at(title, index) 
Inserts a new entry with title at index in the form. If index is out of bounds the method will return nil.
Returns the new form cell.
Ex:
{form my_form}:insert_entry_at("A title:", 2)
#end_method

#begin_method
replace_cell_at(cell, index) 
Replaces the cell at index with cell. If index is out of bounds the method will return nil.
Returns self.
#end_method

#begin_method
scroll_cell_to_visible(index) 
If the form is located in a scroller it will scroll to make the cell at index visible.
Returns self.
#end_method

#begin_method
selected_index 
Returns the index of the selected cell.
#end_method

#begin_method
set_entry_width(width) 
Sets the width of the form to width.
Returns self.
#end_method

#begin_method
set_interline_spacing(spacing) 
Sets the hight between the cells to spacing.
Returns self.
#end_method

Class Methods 

#begin_class_method
new 
Returns a new form object.
Ex:
{form}:new
#end_class_method

#begin_class_method
new_with(number_of_entries) 
Returns a new form object with a number of entries.
Ex:
{form}:new_with(5)
#end_class_method